═══ 1. Cover ═══ Traveling Workplace Version 1.30 Copyright (c) Syntegration Inc. 1995, 1996. All Rights Reserved. 3811 Schaefer Ave #J Chino, CA 91710, U.S.A. Tel: 1-909-464-9450 Fax: 1-909-627-3541 email:73707.3331@COMPUSERVE.COM ═══ 2. License Agreement and Limited Warranty ═══ This program, including its code and documentation, appearance, structure and organization is a product of Syntegration and is protected by copyright and other laws. Title to the program or any copy, modification or merged portion of the program shall at all times remain with Syntegration. LICENSE - The following restricted rights are granted: You may: 1. Use the Program only on a single computer. The Program may be transferred to and used on another computer as long as the program is de-installed from the original computer, and under no circumstances be used on more than one computer at a time. 2. If you purchased an Enterprise Edition license for this Program, you may use the Program on as many computers as you have licensed. 3. Transfer the Program with this license to another person, but only if the other person agrees to accept the terms and conditions of this agreement. If you transfer the Program and License, you must at the same time either transfer all copies of the program and its documentation to the same person or destroy those not transferred. Any transfer terminates your license. 4. Include the program as part of a system that you resell. If you include the program as part of another system you must include this license agreement, acknowledge our copyright in your system documentation, and comply with the transfer clause. YOU MAY NOT: 1. TRANSFER OR RENT THE PROGRAM OR USE, COPY OR MODIFY THE PROGRAM EXCEPT AS PERMITTED IN THIS AGREEMENT. 2. DECOMPILE, REVERSE ASSEMBLE OR OTHERWISE REVERSE ENGINEER THE PROGRAM. 3. REPRODUCE, DISTRIBUTE OR REVISE THE PROGRAM DOCUMENTATION. LIMITED WARRANTY EXCEPT AS SPECIFICALLY STATED IN THIS AGREEMENT, THE PROGRAM IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. Syntegration warrants that the disk on which the Program is furnished will be free from defects in materials and workmanship under normal use for a period of 90 days from the date of delivery to you. ═══ 3. Traveling Workplace ═══ The Traveling Workplace is a tool you can use to backup, restore, and maintain OS/2 workplace images. You can save workplace images as archive sets on a floppy diskette, on your local hard drive, or on a network file server. The Traveling Workplace automatically saves the files that define the settings and icons on an OS/2 desktop. You can select additional files to be saved with the Workplace Image. These additional files will then be recovered when you restore an archive set. You can restore a desktop if the original files are later damaged, corrupted, or changed. If you want to maintain different desktops for each user who access a workstation, Traveling Workplace can immediately restore a workplace image. Immediate means you don't have to shutdown and restart your computer to make the restored workplace active. The Traveling Workplace allows you backup a desktop from one workstation and restore the same desktop on another workstation. With this capability user's can move from one workstation to another and get their own desktop. As an End user you can share your workstation with your children and others without giving them access to your sensitive applications. How about configuring a games only workplace. Network Administrators can provide different workplaces for each of your users or user groups and restore there desktops if they get corrupted. We mean hands-off restore without taking a trip out to the workstation. With the Traveling Workplace the possiblities are endless. For details, select from the list below: o How desktops are defined o Saving the workplace o Restoring an archived workplace o Switching to another workplace o Selecting additional backup files o Archive Location o Preferences o Selecting a log file o Start-up parameters o Portability considerations ═══ 3.1. How desktops are defined ═══ An OS/2 Desktop consists of three elements. These are a User Profile, a System Profile, and a desktop directory including its subdirectories. The User profile is usually named C:\OS2\OS2.INI. The System Profile is usually named C:\OS2\OS2SYS.INI. The desktop directory is usually named C:\DESKTOP. These names are not actually required. The User Profile is defined in the CONFIG.SYS file using the USER_INI environmental variable. The System Profile is defined in the CONFIG.SYS file using the environmental variable SYSTEM_INI. The desktop directory name is defined in the System Profile. Your can have as many desktops resident on your system as you have hard disk space. In fact OS/2 Warp installs two desktops on your boot drive when you install it. The first is your main desktop, and the other is the Maintenance desktop. To switch from one desktop to another all you have to do is change the USER_INI, and SYSTEM_INI environmental variables and reset the workplace. The Traveling Workplace switches desktops automatically for you when you restore an archived workplace. The included Workplace Reset function also allows you switch from one resident desktop to another by selecting new user and system profiles or by selecting from a list of on-line workplaces. With multiple resident desktops on a workstation you can provide one for each user or user group who would access the system. With the Traveling Workplace switching between them is painless. Traveling Workplace lets you restore a desktop without necessarily disturbing the resident desktops on your system. In fact, Traveling Workplace lets you manage up to 36 resident desktops. See Also: o Saving the active workplace o Restoring an archived workplace o Switching between on-line workplaces ═══ 3.2. Saving the workplace ═══ You can save the active workplace into the current archive directory by selecting the backup command from the Workplace menu or from the tool bar. The Traveling Workplace will backup the active desktop as well as the additional files you selected. Usually the progress window will display the files and directories as they are being saved. If you selected a log file these messages will be written to this file at the same time. Error messages are also displayed in the progress window and written to the log file. When the backup is complete the Traveling Workplace will update the list of archives workplaces in its main window. Unattended or background operation. You can invoke the backup operation automatically from a command prompt, REXX program, or from a specifially configured object icon. Your would do this by using the /BACKUP parameter along with any combination of the /LOC, /RSP, /NOLOGO, /NOPROMPT, /MAXREVS, and /LOG parameters. See Also: o Restoring an archived workplace o Start-up parameters o Preferences o Additional backup files ═══ 3.3. Restoring the workplace ═══ You restore a workplace by selecting one from the list of archived workplaces and invoking the restore command from the workplace menu or the tool bar. The Traveling Workplace will restore the archived files associated with the archive set you selected, then restart your workplace to use the restored desktop. The restore procedure can be customized through the preferences window. Usually the progress window will display the files and directories as they are being restored. If you selected a log file these messages will be written to this file at the same time. Error messages are also displayed in the progress window and written to the log file. The workplace restore procedure can be non-destructive. Traveling Workplace will assign new names for the User profile, System profile, and the Desktop directory leaving the active files unchanged. Traveling Workplace works in a replace mode when the Workplace Shell not active. In this case, the backup user profile, system profile, and desktop directory will be replaced. Replace mode is available if you change the RUNWORKPLACE Environment variable to something other than PMSHELL.EXE. (ie. CMD.EXE). If the desktop slot is available Traveling Workplace restores the desktop to its previous name. For instance, suppose the archived desktop was named C:\DESKTOP1 and this desktop is not active then Traveling Workplace deletes the directory and profiles before restoring. This practice reduces the work and reduces the potential for interference with the workplace shell. When the restore is complete, the Traveling Workplace will reset the workplace to switch from the active workplace to the restored workplace. The original CONFIG.SYS is also saved in a new file called CONFIG.TW?. This behavior does not apply to the additional files restored. The additional files in the archive directory will overwrite the originals. If you prefered to cleanup the old workplace files after the restore is complete the Traveling Workplace will delete them. When you turn off the cleanup after preference you will create an additional resident workplace each time you restore an archived workplace. Traveling Workplace will allow you to create up to 36 resident workplaces in this way. After the maximum number of resident workplaces are exceeded the Traveling Workplace will re-use the oldest non-active workplace. If you prefered to re-use the default names the Traveling Workplace will recreate these files and directories if they do not exist. The Traveling Workplace automatically updates your CONFIG.SYS file if that preference was selected. Unattended or background operation. You can invoke the restore operation automatically from a command prompt, REXX program, or from a specifically configured program object icon. Your do this by using the /RESTORE parameter along with any combination of the /LOC, /RSP, /NOLOGO, /NOPROMPT, /REV, /UPDATE, /REUSE, /CLEANUP, /PORTABLE, and /LOG parameters. You should note that the /RSP option is a handy way to combine these parameters without needing to specify them on the command line. See Also: o Saving the workplace o How desktops are defined o Preferences o Additional backup files o Archive Location o Start-up parameters o Portability considerations ═══ 3.4. Create Desktop ═══ The Workplace New function lets you create a new workplace. New desktops give you a fresh start on construction of a custom desktop for users. You can also create a desktop when you restore a workplace by removing the Clean up after Restore preference. To create a new desktop: 1. Select Workplace / New... from the menu. 2. When the Workplace Create Window appears enter a User Resource File and a System Resource file. 3. press the Create pushbutton. Traveling Workplace performs a MAKEINI on the User Resource File to Create a new User Profile. If you Specify a System Resource file Traveling Workplace performs a MAKEINI to create a new System profile. The User Resource file is required, but the System resource file is optional. If you do not specify a System resource file, Traveling Workplace will copy the active system profile and reuse it. The System resource file contains things like Printer driver information, Workplace class information, and System handles. This information may be handy for your new desktop. In fact you will lose some Workplace shell class information if you specify a new System Resource file. Workplace classes may be registered by applications you install. Unless you really want to create a Clean desktop do not specify a system resource file. You can also create another workplace by using the /NEW start-up parameter along with /URC and /SRC. for example, Create a desktop by entering the following command from the command prompt. TWKPLACE /NEW /URC=C:\OS2\INI.RC /SRC=C:\OS2\INISYS.RC /NOUPDATE /NOREUSE If you copy and edit the INI.RC file with a text editor or the Object Editor you can control the objects that will appear in the new desktop. We have provided an example file (BLANKDSK.RC) of how a blank desktop resource file will look. However, It is better to use the INI.RC that was installed on your computer as a starting point. The Object Editor can read the INI.RC and write it back as a new Desktop Resource file. Here is an example Command file fragment that can create a desktop in an unattended mode. Just change the file names to suit you needs. TWKPLACE.EXE /NOPROMPT /NEW /URC=C:\SWP\DATA\NEWDESK.RC Suppose you want to create a minimal desktop that contains a subset of the objects that are normally created by the OS/2 System. Follow this procedure. 1. Start the Object Editor and open the INI.RC file (ie. File/Open/Desktop Resource File) 2. Save the INI.RC to another name. Lets say you used NEWDESK.RC. 3. Remove the objects you do not require. Do not remove the desktop line. 4. Save the NEWDESK.RC file. 5. Start the Traveling workplace and select (Workplace/New) from the menu. 6. Specify the NEWDESK.RC file as the User Resource file. 7. Leave the System Resource file blank. 8. Press Create. 9. Magic happens. Refer to the Object Editor on-line help and the "Customizing the OS/2 Workplace" on-line reference. These documents contain information you will find very handy. HAVE NO FEAR. You can always switch back to the existing desktop. IF YOU FEAR then go to the preferences window and uncheck Update CONFIG.SYS and Reuse Default Names Traveling Workplace gives you maximum safety when experimenting with this operation because you can fall back to an archived workplace or switch to another desktop. ═══ 3.5. Workplace Reset ═══ The Workplace Reset function restarts the Workplace Shell. At the same time, you can switch desktops by specifying new file names for the USER_INI and SYSTEM_INI environment variables. Traveling Workplace uses this function to let you switch between on-line workplaces. To switch to an on-line workplace: 1. Select a workplace from the list of on-line workplaces. 2. Press the reset button or select Workplace / Reset... from the menu. 3. When the Reset Window appears press the Reset pushbutton. You can also switch to another on-line workplace by using the /SWITCH start-up parameter along with /USR and /SYS or /DESKTOP. for example, switch to the default desktop by entering the following command from the command prompt. TWKPLACE /SWITCH /DESKTOP=Desktop ═══ 3.6. Archive Location ═══ The Archive Location window lets you select a directory for saving and restoring workplace images. Use the drive and directory list boxes to navigate to the directory of your choice, or type in the directory name. To create a new directory just type the name into the entry field provided. The Traveling Workplace will automatically create the directory the next time you perform a backup. The archive directory is inspected to create the list of archive sets display in the main window. The Traveling Workplace maintains the files in the archive directory. You should not independently change or delete any files in the archive directory. Multi-user archives. You should maintain a separate archive directory for each user. for instance, Sally uses C:\ARCHIVE\SALLY, Mike uses C:\ARCHIVE\MIKE, KARA uses C:\ARCHIVE\KARA, and so on... The /LOC startup parameter allows you to set the archive directory when the program starts. This overrides the directory you specified here. ═══ 3.7. Selecting additional backup files ═══ The additional files window allows you select files to save. These files are saved along with the user profile, system profile, and the desktop directory when a workplace image backup is performed. These files are also restored along with the workplace image. Select the Add... button to add a file or files to the list. wild card file specifications are accepted. Select an item from the list then press the Delete... button to remove it from the list. Select the Default button to initialize the list with the default set of additional files. When you are done press the OK button to save your changes. ═══ 3.8. Discovering Desktops ═══ When a lot of restore activity takes place in the background the list of on-line Workplaces may become inconsistent with the desktops that actually reside on your hard disk. The Workplace/Discover menu item is provided to allow you to search your hard disk for desktops. The procedure inserts the desktops it finds into the list of on-line workplaces. If a desktop is already in the list with incorrect information, the procedure will update the information. The discover desktops procedure can be useful when you want to delete unnecessary desktops. ═══ 3.9. Workplace Rename ═══ The Workplace Rename function is activated from the Workplace menu. Use this option to rename an item in the list of on-line workplaces. You can enter a new name up to 40 characters long. Besides its use as a title in the list of on-line workplaces, the workplace name can also be used to specify the desktop on the command line. The is achieved through the /DESKTOP startup parameter. The /DESKTOP startup parameter is only used when you also specify the /SWITCH startup parameter. If you plan to use the /DESKTOP startup parameter, then you should select a relatively short name that does not include spaces. See also: o Start-up parameters o Switching to another workplace ═══ 3.10. Workplace Icon ═══ The Workplace Icon function is activated from the Workplace menu. Use this option to create an icon that lets you switch between on-line workplaces. Before selecting this function you must first select an item from the list of on-line workplaces. When you activate this function Traveling Workplace creates a program object on the active desktop. When you double click or open this new object the Traveling Workplace initiates a workplace reset to switch you to the selected workplace. Use the Workplace icons you create to assist you with multi-user setup. See also: o Start-up parameters o Switching to another workplace o Multi-user Setup ═══ 3.11. Selecting Preferences ═══ The Preferences window lets you select options used during backup and restore processing. Your options are described below: On-line Workplaces Using the up or down arrows select the maximum number of resident desktops you want to allow on your workstation. Traveling Workplace will remove the oldest workplace from your workstation when the maximum number is exceeded. The default workplace is not considered in this count and will not be reused unless it was removed manually or by a cleanup after operation. Archive Generations Using the up or down arrows select the number of generations you want to maintain in an archive directory. Traveling Workplace will remove the oldest archived files from this directory when the allowable number of generations are exceeded. Update CONFIG.SYS Check the update button to automatically update your configuration file after restoring a workplace from the archive. If you leave the update button unchecked, then the workplace you restore will not remain active after you shutown and restart your computer. Traveling Workplace will allow you to change your mind after performing a restore. You can manually update the CONFIG.SYS file by selecting the Update Configuration... command from the Workplace Menu. Cleanup desktop files after restore Check the cleanup button to remove the old user profile, system profile, and desktop directory after restoring an archived workplace. The cleanup after operation is not available unless you allow CONFIG.SYS updates. Leave this option unchecked if you want to create multiple resident desktops. Re-use default names on restore Check the Re-use button to allow Traveling Workplace to use the default names when you perform a restore. In any case Traveling workplace will not re-use the default names if the default files exist. Ensure Portability on restore Use this button to run the portability check on a restore. The portability procedure has not been defined as of this writing. You can gain additional control over portability by using the Copy User Applications and the Copy System Applications features. If you have portability concerns contact our technical support staff. We will be happy to assist you with establishing portable restore settings for your environment. Reset Workplace After Operation This button refers to the Workplace restore, Workplace create, and Workplace switch operations. Check this button to allow the Traveling workplace to reset the workplace Immediately after performing the operation. Uncheck this button if you want to defer the workplace reset until after a reboot. For example, Check the Update CONFIG.SYS option and Uncheck the Reset Workplace option if you want to perform a restore but defer the switch until after a system reboot. Copy User Applications With the Copy User Applications list you can select application data that you want to copy from the active user profile to the restored user profile. This mechanism will allow you to keep data from the active desktop that may be more current than the archived workplace. You can also use this list to maintain portability when restoring a workplace that was backed up from a different workstation. Copy System Applications With the Copy System Applications list you can select application data that you want to copy from the active system profile to the restored system profile. This mechanism will allow you to keep data from the active desktop that may be more current than the archived workplace. You can also use this list to maintain portability when restoring a workplace that was backed up from a different workstation. See Also: o How desktops are defined o Restoring an archived workplace o Saving the active workplace o Start-up parameters o Portability considerations ═══ 3.12. Selecting a Log File ═══ The Log File window lets you select a file to be used for writing messages during the backup or restore procedures. A log file can be useful for auditing if you run the program in an unattended mode or from the command line. Use the list boxes to help you navigate the directories and find an existing file. To create a new logfile simply type the name directly into the file name field. The Log file can also be specified through the /LOG command line option or from a response file ═══ 3.13. Progress Log ═══ The progress log window appears when you run Traveling Workplace in the interactive mode. The interactive mode is disabled by specifying the /NOPROMPT command line option. This window gives you details about the operations performed by the Traveling Workplace. The OK is disabled while the operations are being performed. ═══ 3.14. Start-up Parameters ═══ By specifying options, you can start the Traveling Workplace to backup the active workplace, restore an archived workplace, switch between resident workplaces, create a new workplace, or perform these operations in an interactive mode. The Traveling Workplace can run in a number of different modes. These are: o Unattended mode runs invisibly in the background. o Single operation mode with Progress Log window visible. o Interactive mode with main window visible. All operations are controlled manually. You can specify start-up parameters in any of the following ways: o In the Parameters field of the Program page of a Traveling Workplace object's settings notebook. o On the command line of a OS/2 Window or OS/2 Full Screen command prompt. o In a CMD file or program. Use the same syntax as for a command prompt. The command syntax is as follows: TWKPLACE [ options ] The following options are allowed. /NOLOGO Do not display the initial product information window. /NOPROMPT Use this option to start the Traveling workplace to run invisibly in the background. This option is ignored unless you select /RESTORE, /BACKUP, /SWITCH, or /NEW at the same time. If you specify this option then /NOLOGO is assumed. /LOC[=ArchiveLocation] specifies the directory containing the archived workplace images. /LOG[=LogFile] logs all operations to the specified logfile. If no log file is specified the program will write to TWKPLACE.LOG in the current directory. /NOAUDIT disables logging operations and removes the log file selection. /PROF=ParamDir specifies the directory containing the parameter profile. This file is named TRAVELWP.INI. The program reads parameters from this file and saves parameters to this file. /BACKUP backups the current active desktop to the archive directory. This option causes the program to run in single operation mode unless the /NOPROMPT parameter was also specified. /RESTORE restores a workplace image from the archive directory. This option causes the program to run in single operation mode unless the /NOPROMPT parameter was also specified. /SWITCH Switches from one on-line workplace to another. This option causes the program to run in single operation mode unless the /NOPROMPT parameter was also specified. /NEW Creates a new workplace. This option causes the program to run in single operation mode unless the /NOPROMPT parameter was also specified. /USR=USERINI Specifies the new file for the User profile. This option is ignored unless the /SWITCH option is also specified. /SYS=SYSTEMINI Specifies the new file for the System Profile. This option is ignored unless the /SWITCH option is also specified /URC=USERRC Specifies a User Resource file used to construct the new User profile. This parameter is ignored unless the /NEW option is also specified. /SRC=SYSTEMRC Specifies a System Resource file used to construct the new System Profile. This parameter is ignored unless the /NEW option is also specified. /DESKTOP=DESKTOPNAME Switches to the named on-line Workplace. This is an alternative to the /USR and /SYS options when used with the /SWITCH option. /REV=n n indicates the generation to restore. The latest backup in the archive directory is generation (n=0). Each older backup increases the generation by one. If a generation level is not specified, then the latest archive set is restored. /MAXREVS=n n indicates the maximum number of generations that an archive directory can contain. If this number is exceeded then the program will delete the oldest archive set after a backup is performed. /MAXDESKS=n n indicates the maximum number of on-line workplaces allowed on the workstation. If the number is exceeded then the program will delete the oldest on-line workplace before restoring. The program will not delete the default workplace. /NOUPDATE does not update the CONFIG.SYS file after a workplace has been restored. If this option is specified then the restored desktop will not persist when the workstation is restarted. /UPDATE updates the CONFIG.SYS file after a workplace has been restored. /NORESET Prevents Traveling Workplace from reseting the workplace shell as part of an operation. Valid operations are /RESTORE, /SWITCH, and /CREATE. Use this option when you want to perform and operation without immediately switching to the target desktop. You can also specify the /UPDATE option so that the target desktop will be used at the next system restart. Since some versions of the Workplace Shell are very hyperactive in moving unwanted information to the target desktop this option can be useful to delay the activation of a restored or created desktop until after a system reboot. /RESET Sets the Reset Workplace After Operation preference and performs a workplace reset immediately after a /SWITCH, /RESTORE, /CREATE operation. /CLEANUP causes the program to delete the previous workplace files left behind after restoring. If this option is specified then the CONFIG.SYS file will be automatically updated. /NOCLEANUP prevents the program from deleting the previous workplace files left behind after restoring. /REUSE lets the program re-use the default names for the User Profile (\OS2\OS2.INI), System Profile (\OS2\OS2SYS.INI), and the Desktop directory (\DESKTOP). The program will only re-use these names if they do not exist. /NOREUSE indicates that the default names for the User Profile (\OS2\OS2.INI), System Profile (\OS2\OS2SYS.INI), and the Desktop directory (\DESKTOP) should not be used for a restore operation. /PORTABLE causes the program to copy system specific information from the current user and system profiles to the restored profiles. This will ensure portability between different workstations. At the time of this writing no portability testing is defined. /NOPORTABLE ignores system specific information in the current user and system profiles. no portability testing is performed. /RSP=ResponseFile allows you to specify a response file. The Response file can contain all the options needed to perform a backup or restore operation. The Traveling workplace allows you to save response files that you can use with this option. The command line below invokes the Traveling Workplace to restore the latest workplace image from the archives located in the C:\ARCHIVE\KARA subdirectory. TWKPLACE /NOLOGO /LOC=C:\ARCHIVE\KARA /RESTORE See Also: o How parameters are saved o How response files are used o Where parameters are saved ═══ 3.15. How parameters are saved ═══ Traveling Workplace gets its parameters from three places. These are: o The parameter file TRAVELWP.INI o Start-up parameters o A Response file The parameter file is the main location for Traveling Workplace parameters. You can over-ride the values in the parameter file by using a response file. You can over-ride the values in a response file and in the parameter file by using start-up parameters. All changes and over-rides are saved in the parameter file. ═══ 3.16. How response files are used ═══ Response files provide a method for over-riding options that were selected in the parameter file. They are used to control options when you are unsure of values contained in the parameter file. Response files can also be used to supply initial values for the parameter file before it is created. Traveling Workplace allows you to create response files that contain the parameters you interactively select. This feature saves you the time and trouble of creating a response file from scratch. You can read a response file, make changes using the Traveling Workplace facilities, then save the changes back into the response file. Response files are easily edited and viewed with a text editor. Parameters specified on a command line usually over-ride parameters specified in a response file except when you read a response file interactively using the menu. A response file is processed when you specify one with the /RSP start-up parameter. Use the /RSP option along with one of the /BACKUP, /RESTORE, or /SWITCH options for precise control of Traveling Workplace operations from a command line. See Also: o Start-up parameters o Where parameters are saved o How parameters are saved ═══ 3.17. Where parameters are saved ═══ Traveling Workplace saves its parameters in an INI file named TRAVELWP.INI. When you start the Traveling Workplace the program searches for the parameter file in the following order. 1. If the /PROF start-up parameter was specified the program will use this directory to create or open the parameter file. 2. If the /PROF start-up parameter was not specified the program looks in the User Profile for the parameter file location. 3. If the User profile does not contain the parameter file location, then the TWPINI environment variable is searched. 4. If the environmental variable does not exist then the parameter file is opened or created in the current working directory. There are two ways to set the location of the parameters file. 1. Use the /PROF start-up Parameter to specify the parameter file directory. 2. Set the TWPINI environment variable to specify the parameter file directory. This environmental variable is ignored if the User Profile contains the parameter file location. When the Traveling Workplace is initially started and the parameter file is located, the program writes the parameter file name into the active user profile. From then on the Traveling Workplace continues to retain the parameter file name in the active user profile. This retention persists even after a Workplace Restore or Reset operation. Once set, the only way to change the parameter file location is to use the /PROF start-up parameter. In an end user environment where the Traveling Workplace resides on a local Hard Drive the recommended place for the parameter file is in the same directory as the program file. The installation program will set this up for you automatically. In a network environment where the Traveling Workplace resides on a File Server one possible location for the parameter file is in the archive directory. This works if the archive directory allows read and write access to the user. ═══ 3.18. Multi-user Setup ═══ The Traveling Workplace gives you many ways to setup a multi-user workstation. We suggest a few ways in this document and we expect that you will invent a few others by using the start-up options we supply. First of all we suggest that you maintain a separate archive directory for each user or user group. The /LOC startup parameter allows you to set the archive directory when the program starts. Use the preferences window, startup parameters, or response file to prevent updates of the CONFIG.SYS and reuse of the default names. This will allow you to start the workstation with the same default workplace every time. Backup the desktop, restore it, update CONFIG.SYS, shutdown, restart, then backup it up again. This will make the desktop stable and give it a new name. Lets say this archived desktop is DESKTOP0. Now every time you restore the desktop will want to use the DESKTOP0 slot. Switch back to your default desktop (DESKTOP) and update the CONFIG.SYS. Now every time you boot the workplace will default to DESKTOP. The restore operation is clean because the DESKTOP0 slot is available. Now here are two scenarios for setting up a multi-user workstation. o Single station o Network station See Also: o Saving the workplace o Preferences o Start-up parameters ═══ 3.18.1. Single station setup ═══ The single station setup calls for you to start the same default workplace every time. Create program icons on the default desktop to restore the workplace of each user. Here is the detailed procedure. 1. Start the Traveling Workplace. 2. Note the names of the User profile and System profile displayed in the main window for later use. 3. Backup the default desktop into the archive directory (eg. C:\ARCHIVE\DEFAULT). 4. Select a new archive directory for the new user. (eg. C:\ARCHIVE\KARA). 5. Backup the desktop again into the new archive directory. 6. Bring up the preferences menu. a. uncheck the Update CONFIG.SYS button. b. uncheck the Reuse default names button. c. uncheck the cleanup after button. d. select about 9 archive generations. e. select 3 or more resident workplaces as you have users. f. Press the OK button. 7. Save a response file into the new user's archive directory (eg.C:\ARCHIVE\KARA\KARA.RSP). Note this name for future reference. 8. Restore the new user desktop. If you followed previous instructions the the default workplace will remain intact. 9. Now we want to create an icon that will allow you to return to the default desktop. Open the templates folder and drag a program template from the folder and drop it on the desktop. 10. When the setting window appears enter the following information. a. Go to the program page. You should already be there. b. Enter Traveling Workplace path and file name into the path an filename field (eg.C:\SWP\BIN\TWKPLACE.EXE). c. Enter "/SWITCH /USR=C:\OS2\OS2.INI /SYS=C:\OS2SYS.INI" into the parameters field. Leave the quotes out. if the User profile you noted in step 2 is different then use the name you noted instead of C:\OS2\OS2.INI. If the System profile is different the use the name you noted instead of C:\OS2\OS2SYS.INI. d. Leave the working directory blank. It does not matter. e. Go to the General page and type Logoff in the title field. f. Chose the reset icon provided if you desire. This icon (RESET.ICO) is located in the \BIN subdirectory of the Traveling Workplace's install directory. g. Close the setting window. 11. Now we want to create a program that will allow the user to backup their own desktop. Drag another program template from the templates folder and drop in on the desktop. 12. When the setting notebook appears enter the following information. a. Go to the program page. You should already be there. b. Enter Traveling Workplace path and file name into the path an filename field (eg.C:\SWP\BIN\TWKPLACE.EXE). c. Enter "/BACKUP /RSP=C:\ARCHIVE\KARA\KARA.RSP" into the parameters field. Leave the quotes out. d. Leave the working directory blank. It does not matter. e. Go to the General page and type "Workplace Backup" in the title field. f. Chose the backup icon provided if you desire. This icon (BACKUP.ICO) is located in the \BIN subdirectory of the Traveling Workplace's install directory. g. Close the settings window. 13. Make any additional changes you desire. You may want to delete any objects you want to prevent the new user from accessing. 14. Close the templates folder. 15. Again backup the new workplace into the user archive directory to save your changes. 16. Select the Logoff icon you just created to switch back to the default desktop. 17. Now we want to create a program icon on the default desktop that will allow you to restore the new user's desktop Open the templates folder and drag a program template from the folder and drop it on the desktop. 18. When the setting window appears enter the following information. a. Go to the program page. You should already be there. b. Enter Traveling Workplace path and file name into the path an filename field (eg.C:\SWP\BIN\TWKPLACE.EXE). c. Enter "/RESTORE /LOC=C:\ARCHIVE\KARA" into the parameters field. Leave the quotes out. d. Leave the working directory blank. It does not matter. e. Go to the General page and type Kara's Desktop in the title field. f. Chose the restore icon provided if you desire. This icon (RESTORE.ICO) is located in the \BIN subdirectory of the Traveling Workplace's install directory. g. If you purchased and installed The Secure Workplace from Syntegration then you can assign a password to this object. h. Close the setting window. 19. Repeat this procedure for each user. ═══ 3.18.2. Network station setup ═══ The Network station setup calls for you to start the same default workplace every time. When the user logs-on restore their workplace. When the user logs-off, backup their workplace. Each environment has its own considerations. Therefore you should refer to the command line start-up parameters to implement the backup and restore procedures to fit your requirements. Archive location considerations You should maintain a different archive directory for each user or user group. This prevents workplace images from being mixed up. As an administrator you make the drive assignments. If you want to maintain a unique desktop for each user then you should assign the user's archive directory as a subdirectory of their home drive. If you want to maintain a unique desktop for each user group then you should assign a drive letter that will point each user group to a different archive directory. For example, say drive L: contains the archive directory. User group A would have one drive L: assignment and User Group B would have a different Drive L: assignment. For the purposes of this example lets assume that the archive location is L:\ARCHIVE. Preference considerations In network environment we want to the workstation to boot to the same default desktop no matter who was last logged on. We also want the default desktop to contain a logon icon that will start the logon procedure. Here is the setup procedure. 1. Start the Traveling Workplace. 2. Bring up the preferences window. a. uncheck the Update CONFIG.SYS button. b. uncheck the Reuse default names button. c. uncheck the cleanup after button. d. Allow about 9 archive generations. e. Allow at least 3 resident workplaces. f. Press the OK button. 3. Backup the default desktop into the archive directory (eg. C:\ARCHIVE\DEFAULT). 4. Change the archive location to the network archive L:\ARCHIVE 5. Backup the desktop into the user's archive directory 6. Restore the desktop so it uses a name other than the default (eg.DESKTOP0). 7. Backup the desktop again. Now the archived desktop uses a name other than the default. When the user restores it the slot should be available. 8. Save the parameters to a response file that you can modify later. 9. Create an icon that starts the logon procedure. If you network operating system has preinstalled a logon icon then use it. 10. Cleanup the default desktop by deleting any objects that the user should not access before logon. You may want to create a default desktop that has nothing but a logon icon. Traveling Workplace can create a new desktop for you. Logon considerations After a user logs-on, we will restore his workplace from the archive directory. We do this in his logon script. Each network operating system implements logon scripts in different ways. LAN Server's logon script is called PROFILE.CMD. Insert the following command line in the user's logon script. TWKPLACE /NOPROMPT /LOC=L:\ARCHIVE /RESTORE /NOREUSE /NOUPDATE You could use the /RSP start-up parameter instead to reduce the size of the command line. Logoff considerations When the user logs-off we may want to backup any changes he made to the workplace. We also want to switch back to the default desktop to allow the next user to logon. Since most network operating systems do not have logoff scripts we should create a logoff icon on the user's desktop. the logoff icon could start a command file or REXX program that performs the backup and then logs the user off. Here is a sample command file that backs-up, logs-off, and switches. @ECHO OFF TWKPLACE /NOPROMPT /LOC=L:\ARCHIVE /BACKUP /MAXREVS=9 LOGOFF.EXE TWKPLACE /NOPROMPT /SWITCH /USR=C:\OS2\OS2.INI /SYS=C:\OS2\OS2SYS.INI EXIT In the case of user groups we probably do not want to automatically backup changes that any one user makes. If this is the case, then you do not need to perform a backup before the use logs-off. One side benefit to this strategy is that the user gets the same desktop every time he logs-on. Maintenance considerations Sometimes administrators need to deploy new workplace configurations. That task becomes easy when the archive directory is on a File Server. here is a procedure that will allow you to modify a User or User group workplace. 1. Start the Traveling Workplace. 2. Change the archive location to point at the user's archive directory. 3. Switch to a desktop that does not have the same name as the archived desktop. The archived desktop name is written on the second line of the progress log. You want to allow the users desktop the keep its name (ie.Slot). 4. Restore the workplace from the archive. 5. Make the required changes to the desktop. 6. Wait a minute to allow the User Profile or System Profile to get updated. 7. Backup the workplace to the archive. Next time the user logs-on his desktop will be updated. OS/2 V3.0 and later takes proactive steps to maintain system handle information. When Traveling Workplace has to rename the desktop by updating object and system handles the possibility of clashes is high. Once you have gotten the desktop to use a new name try your best to maintain it. The "Frequently Asked Questions" document has more information on this topic. ═══ 3.19. Portability considerations ═══ Portability could be an issue if you plan to backup a desktop on one machine and restore it on another. In a homogeneous environment where the hardware and software is the same Portability is not a problem. Hardware differences such as Microprocessor types, Hard drive types, Floppy drive types, serial ports, and parallel ports do NOT make a computer different as far as OS/2 and the Workplace configuration is concerned. Again, if these are the only differences then you need not be concerned with portability. The Traveling Workplace allows you to painlessly experiment with restoring workplace images you backed up on another machine. You can do this by turning off the clean-up after restore and Update CONFIG.SYS preferences. When you perform a restore in this way the existing workplace image is left intact. To switch back to the original workplace just select it from the list of on-line workplaces and press the reset button. If the restored image is unsatisfactory delete it. If one or more of the following conditions apply to the source and target machines the restore procedure may not work well without cogent customization. o Different version of the OS/2 operating system. o Different display device drivers. o Different installed printer drivers. o Different sound card drivers. o Different installed fonts. o Different application software. The following discussion addresses the main types of hardware and software differences. We will try to offer solutions that will help you to customize the restore procedure when portability becomes an issue. Mice The mouse driver is configured in the CONFIG.SYS. If you have mice that use different drivers then as long as you do not restore the CONFIG.SYS as an additional file then you need not be concerned with portability. Hard Drives, Floppy Drives, and CD-ROM Drives The same argument for mice applies to CD-ROM drives. You need not worry about hard drives or floppy drives because the Drives folder dynamically creates an object for each available drive when you activate it. Thus, even if the restored drives folder is initially incorrect, the Workplace shell will self-correct the objects when the folder is next opened. Video display cards The video display drivers are configured in the CONFIG.SYS file. Inspect the CONFIG.SYS file to determine if the display driver references are different. If they are different then you should not backup the CONFIG.SYS from the source machine and restore in on the target machine. sometimes display device drive parameters are stored in the User Profile (OS2.INI) or the System Profile (OS2SYS.INI). Inspect the applications listed in the Preferences window. Select the applications you believe to be related to the display driver. Some experimentation is required here. Once you believe you have the right set of applications try the restore. You should be looking for applications with names like PM_DISPLAYDRIVERS, WIN_RES_*, PM_IBMBGA, or PM_IBMXGA. By copying the application data from the active profiles to the restored profiles you will effectively be transfering the information the workstation needs to run on the target machine. Printer drivers. If the target machine does not have a printer driver to support a printer object backed up from the source machine then you have a problem. The solution is simple. Install the driver on the target machine before restoring the workplace image. If the target machine has more drivers than the source machine you have no problem. Both the User Profile and the System profile contain information needed by the system to manage printers. If the printer port assignments on the source machine are different to the ports assignments on the target machine then the application data may need to be copied from the active profiles to the restored profiles. Sound cards. The sound drivers are configured in the CONFIG.SYS file. Inspect the CONFIG.SYS file in the source and target machines. If the sound card drivers are different then you should not backup the CONFIG.SYS from the source machine and restore in on the target machine. Multimedia PM configuration information is stored in the \MMOS2\MMPM.INI file. This information is not backed up or restored unless you selected the file as an additional backup file. In this scenario the target machine will retain its MMPM configuration. Installed fonts. If the source machine has fonts that the target machine does not have then you have two alternatives. You could install the missing fonts on the target machine before performing a restore or copy the font information from the active user profile to the restored user profile. The copy applications preferences allow you to do this during the restore procedure. The applications are "PM_fonts", an "PM_Font_Drivers". Perhaps the best approach is to ensure that all of your machines have the same fonts. Application software The target machine should have access to at least the same application software as the source machine. The software should be installed in the same drive and directories on both machines. If this were not the case, then the objects in the restored workplace would point to non-existent locations. Obviously you would not want to restore a workplace to a target machine that has none of the same software. Network software Both the source machine and the target machine should have the same network software installed. The arguments for application software apply. Network adapter cards Network adapter drivers are usually configured in the CONFIG.SYS file. Inspect the CONFIG.SYS file in the source and target machines. If the network adapter drivers are different then you should not backup the CONFIG.SYS from the source machine and restore it on the target machine. OS/2 version differences. The User profile and System profiles have slight differences with different versions of the OS/2 Operating System. Your might be able to backup and restore workplaces between V2.1 and V2.11. You might have the same luck between Warp Fullpack and Warp for windows. Warp Connect is a different animal. In general we suggest that you upgrade and maintain all your machines at the same version of the operating system. If you must restore a workplace onto a target machine with a different OS/2 version then we recommend that you inspect the application data in both the user and system profiles. Use the copy applications capability in the preferences window to copy data from the active profiles to the restored profiles. See Also: o Preferences o Selecting additional backup files o Start-up parameters ═══ 3.20. The Menu ═══ The following pages describe The Workplace Image Archiver's Menu options. ═══ 3.20.1. Workplace Menu ═══ The Workplace menu contains commands that you use to backup and restore workplace images. The following commands appear in the menu: Backup Stores the current workplace into the archive directory. Restore Restores the selected workplace archive set. Remove Archive Removes the selected workplace archive set from the archive directory. Delete Deletes the selected on-line workplace. Save response file Save the backup and restore parameters in a file Read response file Reads parameters from a file. Update Configuration Updates your CONFIG.SYS file after last restore ═══ 3.20.1.1. Workplace Backup ═══ Use the Backup command to store the current workplace into the archive directory. For more information see Saving the workplace ═══ 3.20.1.2. Workplace Restore ═══ Restores the selected archive set. From more information see Restoring an archived workplace ═══ 3.20.1.3. Workplace Target ═══ Displays an information panel that tells you where the selected archive will be restored. The information depends on the active desktop, the archived desktop, the number of allowed on-line workplaces, and the Re-use Default Names preference. The target is usually the same as the archived desktop unless the archived desktop directory is the same as the active desktop directory. Restoring an archived workplace ═══ 3.20.1.4. Remove Archive Set ═══ The Remove Archive command lets you delete the files associated with the selected archive set. This option cleans up the archive directory and frees disk space. ═══ 3.20.1.5. Workplace Delete ═══ The Workplace Delete command lets you delete the selected on-line workplace. This option deletes the user profile, system profile and desktop directory associated with the workplace. Traveling workplace will not allow you to delete the active workplace. ═══ 3.20.1.6. Save Response File ═══ The Save Response File command lets you select a file for saving the program parameters. this response file can be used later to run the Traveling Workplace in an unattended mode or from a command prompt. See Also: Startup Parameters ═══ 3.20.1.7. Read Response File ═══ The Read Response File command lets you select a parameter file that was previously saved. Traveling workplace will replace its' current parameters with the parameters in the response file. See Also: Startup Parameters ═══ 3.20.1.8. Update Configuration ═══ Use Update Configuration to manually update your CONFIG.SYS after restoring a workplace. This option is available if you choose not to have the update done automatically during the restore. Updating the CONFIG.SYS is necessary if your want to allow the restored workplace to persist after system shutdown. ═══ 3.20.2. Options Menu ═══ Options Menu ═══ 3.20.2.1. Archive Location ═══ The Archive location command lets you select a new directory for saving and restoring Workplace Images. For more information see selecting the archive location. ═══ 3.20.2.2. Additional files ═══ The Additional files command lets you select files to backup. These files are saved along with the user profile, system profile, and the desktop directory when a workplace image backup is performed. For more information see selecting additional backup files. ═══ 3.20.2.3. Preferences ═══ The Preferences... command lets you select options for managing the Workplace backup and restore procedures. For additional information see selecting preferences. ═══ 3.20.2.4. Log File ═══ The Log File command lets you select a file to be used for writing messages during the backup or restore procedures. A log file can be useful for auditing if you run the program in an unattended mode or from the command line. For more information see selecting a log file. ═══ 3.20.2.5. Disable log file ═══ The Disable log command lets you remove the log file selection. When you remove the log file auditing will no longer occur. You can re-initiate auditing by selecting a new log file. ═══ 3.20.3. Help Menu ═══ Use the choices on the Help menu to display: o An index of references to the help topics for the active program o General information about the contents of the active window o General information about the help facility o A list and description of keys you can use o Product information for the active program. ═══ 3.20.3.1. Help For Help ═══ To get information on a particular item, place the cursor on the item then press the Help Key (F1). ═══ 3.20.3.2. Keys Help ═══ Accelerator keys ═══ 3.20.3.3. Help for Help Index ═══ Use the Help index to display an alphabetical list of references to help topics in the active program. You can select an index entry to display the Help topic related to that index entry. ═══ 3.20.3.4. Help for Help Table of contents ═══ Use the Help Contents to display the on-line help table of contents. ═══ 3.20.3.5. Product Information ═══ Select this menu item to display the product information window.